<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: Macros</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__pra__macros.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a>  </div>
  <div class="headertitle">
<div class="title">Macros<div class="ingroups"><a class="el" href="group__group__pra.html">PRA          (Protected Register Access)</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga0b5bfc5991a5627c539970d0eadfab6d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pra__macros.html#ga0b5bfc5991a5627c539970d0eadfab6d">CY_PRA_REG32_CLR_SET</a>(regIndex,  field,  value)&#160;&#160;&#160;(void)<a class="el" href="group__group__pra__functions.html#ga0a1b71a4d148280527ca98aba144a6f4">Cy_PRA_SendCmd</a>(CY_PRA_MSG_TYPE_REG32_CLR_SET, (regIndex), ((uint32_t)(~(field ## _Msk))), (_VAL2FLD(field, (value))))</td></tr>
<tr class="memdesc:ga0b5bfc5991a5627c539970d0eadfab6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides get-clear-modify-write operations with a name field and value and writes a resulting value to the 32-bit register.  <a href="#ga0b5bfc5991a5627c539970d0eadfab6d">More...</a><br /></td></tr>
<tr class="separator:ga0b5bfc5991a5627c539970d0eadfab6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5ce9fb4d14bcb5785633ae9c85e2df30"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pra__macros.html#ga5ce9fb4d14bcb5785633ae9c85e2df30">CY_PRA_REG32_SET</a>(regIndex,  value)&#160;&#160;&#160;(void)<a class="el" href="group__group__pra__functions.html#ga0a1b71a4d148280527ca98aba144a6f4">Cy_PRA_SendCmd</a>(CY_PRA_MSG_TYPE_REG32_SET, (regIndex), (value), 0UL)</td></tr>
<tr class="memdesc:ga5ce9fb4d14bcb5785633ae9c85e2df30"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes the 32-bit value to the specified register.  <a href="#ga5ce9fb4d14bcb5785633ae9c85e2df30">More...</a><br /></td></tr>
<tr class="separator:ga5ce9fb4d14bcb5785633ae9c85e2df30"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadbc5a2cdc6f66a5803bf63e0af1a23ed"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pra__macros.html#gadbc5a2cdc6f66a5803bf63e0af1a23ed">CY_PRA_REG32_GET</a>(regIndex)&#160;&#160;&#160;(uint32_t) <a class="el" href="group__group__pra__functions.html#ga0a1b71a4d148280527ca98aba144a6f4">Cy_PRA_SendCmd</a>(CY_PRA_MSG_TYPE_REG32_GET, (regIndex), 0UL, 0UL)</td></tr>
<tr class="memdesc:gadbc5a2cdc6f66a5803bf63e0af1a23ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the 32-bit value from the specified register.  <a href="#gadbc5a2cdc6f66a5803bf63e0af1a23ed">More...</a><br /></td></tr>
<tr class="separator:gadbc5a2cdc6f66a5803bf63e0af1a23ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa7a72304bfc3b78286931e2785292b20"><td class="memItemLeft" align="right" valign="top"><a id="gaa7a72304bfc3b78286931e2785292b20"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pra__macros.html#gaa7a72304bfc3b78286931e2785292b20">CY_PRA_CM0_WAKEUP</a>()&#160;&#160;&#160;(void)<a class="el" href="group__group__pra__functions.html#ga0a1b71a4d148280527ca98aba144a6f4">Cy_PRA_SendCmd</a>(CY_PRA_MSG_TYPE_CM0_WAKEUP, (uint16_t) 0U, 0UL, 0UL)</td></tr>
<tr class="memdesc:gaa7a72304bfc3b78286931e2785292b20"><td class="mdescLeft">&#160;</td><td class="mdescRight">The request to wake up the Cortex-M0+ core. <br /></td></tr>
<tr class="separator:gaa7a72304bfc3b78286931e2785292b20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7e686246b491a0c07450e1a38aba9138"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pra__macros.html#ga7e686246b491a0c07450e1a38aba9138">CY_PRA_FUNCTION_CALL_RETURN_PARAM</a>(msgType,  funcIndex,  <a class="el" href="group__group__ipc__bt__data__structures.html#gaba18f3d521fde3af39c58b809a9c7ef0">param</a>)&#160;&#160;&#160;<a class="el" href="group__group__pra__functions.html#ga0a1b71a4d148280527ca98aba144a6f4">Cy_PRA_SendCmd</a>((msgType), (funcIndex), (uint32_t)(<a class="el" href="group__group__ipc__bt__data__structures.html#gaba18f3d521fde3af39c58b809a9c7ef0">param</a>), 0UL)</td></tr>
<tr class="memdesc:ga7e686246b491a0c07450e1a38aba9138"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calls the specified function with the provided parameter and returns the execution status.  <a href="#ga7e686246b491a0c07450e1a38aba9138">More...</a><br /></td></tr>
<tr class="separator:ga7e686246b491a0c07450e1a38aba9138"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac5df78d09db2907ecc28da73255e84a4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pra__macros.html#gac5df78d09db2907ecc28da73255e84a4">CY_PRA_FUNCTION_CALL_RETURN_VOID</a>(msgType,  funcIndex)&#160;&#160;&#160;<a class="el" href="group__group__pra__functions.html#ga0a1b71a4d148280527ca98aba144a6f4">Cy_PRA_SendCmd</a>((msgType), (funcIndex), 0UL, 0UL)</td></tr>
<tr class="memdesc:gac5df78d09db2907ecc28da73255e84a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calls the specified function without a parameter and returns the execution status.  <a href="#gac5df78d09db2907ecc28da73255e84a4">More...</a><br /></td></tr>
<tr class="separator:gac5df78d09db2907ecc28da73255e84a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab415d3768041c32c4a8e9e57ac6707ea"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pra__macros.html#gab415d3768041c32c4a8e9e57ac6707ea">CY_PRA_FUNCTION_CALL_VOID_PARAM</a>(msgType,  funcIndex,  <a class="el" href="group__group__ipc__bt__data__structures.html#gaba18f3d521fde3af39c58b809a9c7ef0">param</a>)&#160;&#160;&#160;(void)<a class="el" href="group__group__pra__functions.html#ga0a1b71a4d148280527ca98aba144a6f4">Cy_PRA_SendCmd</a>((msgType), (funcIndex), (uint32_t)(<a class="el" href="group__group__ipc__bt__data__structures.html#gaba18f3d521fde3af39c58b809a9c7ef0">param</a>), 0UL)</td></tr>
<tr class="memdesc:gab415d3768041c32c4a8e9e57ac6707ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calls the specified function with the provided parameter and returns void.  <a href="#gab415d3768041c32c4a8e9e57ac6707ea">More...</a><br /></td></tr>
<tr class="separator:gab415d3768041c32c4a8e9e57ac6707ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga98cc2cf17d3299053c6598e437518ab1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pra__macros.html#ga98cc2cf17d3299053c6598e437518ab1">CY_PRA_FUNCTION_CALL_VOID_VOID</a>(msgType,  funcIndex)&#160;&#160;&#160;(void)<a class="el" href="group__group__pra__functions.html#ga0a1b71a4d148280527ca98aba144a6f4">Cy_PRA_SendCmd</a>((msgType), (funcIndex), 0UL, 0UL)</td></tr>
<tr class="memdesc:ga98cc2cf17d3299053c6598e437518ab1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calls the specified function without a parameter and returns void.  <a href="#ga98cc2cf17d3299053c6598e437518ab1">More...</a><br /></td></tr>
<tr class="separator:ga98cc2cf17d3299053c6598e437518ab1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1d80b007872bb0d1b2d03b803ee6b81b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pra__macros.html#ga1d80b007872bb0d1b2d03b803ee6b81b">CY_PRA_GET_PIN_PROT_TYPE</a>(base,  pinNum)&#160;&#160;&#160;<a class="el" href="group__group__pra__functions.html#gabf68486fc4060570c7a339614bb634d8">Cy_PRA_GetPinProtType</a>(base, pinNum)</td></tr>
<tr class="memdesc:ga1d80b007872bb0d1b2d03b803ee6b81b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares the PORT and PIN number with secure PIN list and returns PIN protection type.  <a href="#ga1d80b007872bb0d1b2d03b803ee6b81b">More...</a><br /></td></tr>
<tr class="separator:ga1d80b007872bb0d1b2d03b803ee6b81b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga63fe5ccec7cac90e919b10356109f650"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pra__macros.html#ga63fe5ccec7cac90e919b10356109f650">CY_PRA_IS_PORT_SECURE</a>(base)&#160;&#160;&#160;<a class="el" href="group__group__pra__functions.html#ga92699262d8e1654b7f9c6a48b658997d">Cy_PRA_IsPortSecure</a>(base)</td></tr>
<tr class="memdesc:ga63fe5ccec7cac90e919b10356109f650"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares the PORT with secure PIN list and returns PORT protection status.  <a href="#ga63fe5ccec7cac90e919b10356109f650">More...</a><br /></td></tr>
<tr class="separator:ga63fe5ccec7cac90e919b10356109f650"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab940cb3aaf5fa67f9e557cc962821ee3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pra__macros.html#gab940cb3aaf5fa67f9e557cc962821ee3">CY_PRA_GET_PORT_REG_INDEX</a>(base,  subIndex)&#160;&#160;&#160;<a class="el" href="group__group__pra__functions.html#ga75141de8e5b3bf6600dc800b66128af6">Cy_PRA_GetPortRegIndex</a>(base, subIndex)</td></tr>
<tr class="memdesc:gab940cb3aaf5fa67f9e557cc962821ee3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares the PORT and PIN number with secure PIN list and returns PORT index.  <a href="#gab940cb3aaf5fa67f9e557cc962821ee3">More...</a><br /></td></tr>
<tr class="separator:gab940cb3aaf5fa67f9e557cc962821ee3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga83fb16d9d89322be1a9f69330e440c5d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__pra__macros.html#ga83fb16d9d89322be1a9f69330e440c5d">CY_PRA_GET_HSIOM_REG_INDEX</a>(base,  subIndex)&#160;&#160;&#160;<a class="el" href="group__group__pra__functions.html#ga5850ddafe9e4383265d32842f6124854">Cy_PRA_GetHsiomRegIndex</a>(base, subIndex)</td></tr>
<tr class="memdesc:ga83fb16d9d89322be1a9f69330e440c5d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares the PORT with secure PIN list and returns HSIOM port index.  <a href="#ga83fb16d9d89322be1a9f69330e440c5d">More...</a><br /></td></tr>
<tr class="separator:ga83fb16d9d89322be1a9f69330e440c5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga0b5bfc5991a5627c539970d0eadfab6d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0b5bfc5991a5627c539970d0eadfab6d">&#9670;&nbsp;</a></span>CY_PRA_REG32_CLR_SET</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CY_PRA_REG32_CLR_SET</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">regIndex, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">field, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">value&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;(void)<a class="el" href="group__group__pra__functions.html#ga0a1b71a4d148280527ca98aba144a6f4">Cy_PRA_SendCmd</a>(CY_PRA_MSG_TYPE_REG32_CLR_SET, (regIndex), ((uint32_t)(~(field ## _Msk))), (_VAL2FLD(field, (value))))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Provides get-clear-modify-write operations with a name field and value and writes a resulting value to the 32-bit register. </p>
<dl class="section note"><dt>Note</dt><dd>An attempt to access not-supported registers (not secure and not listed in the TRM) results in an error. The list of the registers that can be accessed by the PRA driver directly is defined in the cy_pra.h file with the CY_PRA_INDX_ prefix.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">regIndex</td><td>The register address index.</td></tr>
    <tr><td class="paramname">field</td><td>The field to be updated.</td></tr>
    <tr><td class="paramname">value</td><td>The value to write. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga5ce9fb4d14bcb5785633ae9c85e2df30"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5ce9fb4d14bcb5785633ae9c85e2df30">&#9670;&nbsp;</a></span>CY_PRA_REG32_SET</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CY_PRA_REG32_SET</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">regIndex, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">value&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;(void)<a class="el" href="group__group__pra__functions.html#ga0a1b71a4d148280527ca98aba144a6f4">Cy_PRA_SendCmd</a>(CY_PRA_MSG_TYPE_REG32_SET, (regIndex), (value), 0UL)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Writes the 32-bit value to the specified register. </p>
<dl class="section note"><dt>Note</dt><dd>An attempt to access not-supported registers (not secure and not listed in the TRM) results in an error. The list of the registers that can be accessed by the PRA driver directly is defined in the cy_pra.h file with the CY_PRA_INDX_ prefix.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">regIndex</td><td>The register address index.</td></tr>
    <tr><td class="paramname">value</td><td>The value to write. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gadbc5a2cdc6f66a5803bf63e0af1a23ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadbc5a2cdc6f66a5803bf63e0af1a23ed">&#9670;&nbsp;</a></span>CY_PRA_REG32_GET</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CY_PRA_REG32_GET</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">regIndex</td><td>)</td>
          <td>&#160;&#160;&#160;(uint32_t) <a class="el" href="group__group__pra__functions.html#ga0a1b71a4d148280527ca98aba144a6f4">Cy_PRA_SendCmd</a>(CY_PRA_MSG_TYPE_REG32_GET, (regIndex), 0UL, 0UL)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reads the 32-bit value from the specified register. </p>
<dl class="section note"><dt>Note</dt><dd>An attempt to access not-supported registers (not secure and not listed in the TRM) results in an error. The list of the registers that can be accessed by the PRA driver directly is defined in the cy_pra.h file with the CY_PRA_INDX_ prefix.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">regIndex</td><td>The register address index.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The read value. </dd></dl>

</div>
</div>
<a id="ga7e686246b491a0c07450e1a38aba9138"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7e686246b491a0c07450e1a38aba9138">&#9670;&nbsp;</a></span>CY_PRA_FUNCTION_CALL_RETURN_PARAM</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CY_PRA_FUNCTION_CALL_RETURN_PARAM</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">msgType, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">funcIndex, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><a class="el" href="group__group__ipc__bt__data__structures.html#gaba18f3d521fde3af39c58b809a9c7ef0">param</a>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;<a class="el" href="group__group__pra__functions.html#ga0a1b71a4d148280527ca98aba144a6f4">Cy_PRA_SendCmd</a>((msgType), (funcIndex), (uint32_t)(<a class="el" href="group__group__ipc__bt__data__structures.html#gaba18f3d521fde3af39c58b809a9c7ef0">param</a>), 0UL)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Calls the specified function with the provided parameter and returns the execution status. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">msgType</td><td>The function type.</td></tr>
    <tr><td class="paramname">funcIndex</td><td>The function reference.</td></tr>
    <tr><td class="paramname">param</td><td>The pointer to the function parameter.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The function execution status. </dd></dl>

</div>
</div>
<a id="gac5df78d09db2907ecc28da73255e84a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac5df78d09db2907ecc28da73255e84a4">&#9670;&nbsp;</a></span>CY_PRA_FUNCTION_CALL_RETURN_VOID</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CY_PRA_FUNCTION_CALL_RETURN_VOID</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">msgType, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">funcIndex&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;<a class="el" href="group__group__pra__functions.html#ga0a1b71a4d148280527ca98aba144a6f4">Cy_PRA_SendCmd</a>((msgType), (funcIndex), 0UL, 0UL)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Calls the specified function without a parameter and returns the execution status. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">msgType</td><td>The function type.</td></tr>
    <tr><td class="paramname">funcIndex</td><td>The function reference.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The function execution status. </dd></dl>

</div>
</div>
<a id="gab415d3768041c32c4a8e9e57ac6707ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab415d3768041c32c4a8e9e57ac6707ea">&#9670;&nbsp;</a></span>CY_PRA_FUNCTION_CALL_VOID_PARAM</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CY_PRA_FUNCTION_CALL_VOID_PARAM</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">msgType, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">funcIndex, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><a class="el" href="group__group__ipc__bt__data__structures.html#gaba18f3d521fde3af39c58b809a9c7ef0">param</a>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;(void)<a class="el" href="group__group__pra__functions.html#ga0a1b71a4d148280527ca98aba144a6f4">Cy_PRA_SendCmd</a>((msgType), (funcIndex), (uint32_t)(<a class="el" href="group__group__ipc__bt__data__structures.html#gaba18f3d521fde3af39c58b809a9c7ef0">param</a>), 0UL)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Calls the specified function with the provided parameter and returns void. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">msgType</td><td>The function type.</td></tr>
    <tr><td class="paramname">funcIndex</td><td>The function reference.</td></tr>
    <tr><td class="paramname">param</td><td>The pointer to the function parameter. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga98cc2cf17d3299053c6598e437518ab1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga98cc2cf17d3299053c6598e437518ab1">&#9670;&nbsp;</a></span>CY_PRA_FUNCTION_CALL_VOID_VOID</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CY_PRA_FUNCTION_CALL_VOID_VOID</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">msgType, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">funcIndex&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;(void)<a class="el" href="group__group__pra__functions.html#ga0a1b71a4d148280527ca98aba144a6f4">Cy_PRA_SendCmd</a>((msgType), (funcIndex), 0UL, 0UL)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Calls the specified function without a parameter and returns void. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">msgType</td><td>The function type.</td></tr>
    <tr><td class="paramname">funcIndex</td><td>The function reference. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga1d80b007872bb0d1b2d03b803ee6b81b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1d80b007872bb0d1b2d03b803ee6b81b">&#9670;&nbsp;</a></span>CY_PRA_GET_PIN_PROT_TYPE</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CY_PRA_GET_PIN_PROT_TYPE</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">base, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">pinNum&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;<a class="el" href="group__group__pra__functions.html#gabf68486fc4060570c7a339614bb634d8">Cy_PRA_GetPinProtType</a>(base, pinNum)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Compares the PORT and PIN number with secure PIN list and returns PIN protection type. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>GPIO Port address</td></tr>
    <tr><td class="paramname">pinNum</td><td>GPIO PIN number</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The categories of PIN. </dd></dl>

</div>
</div>
<a id="ga63fe5ccec7cac90e919b10356109f650"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga63fe5ccec7cac90e919b10356109f650">&#9670;&nbsp;</a></span>CY_PRA_IS_PORT_SECURE</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CY_PRA_IS_PORT_SECURE</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">base</td><td>)</td>
          <td>&#160;&#160;&#160;<a class="el" href="group__group__pra__functions.html#ga92699262d8e1654b7f9c6a48b658997d">Cy_PRA_IsPortSecure</a>(base)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Compares the PORT with secure PIN list and returns PORT protection status. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>GPIO Port address</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if port is secure otherwise false. </dd></dl>

</div>
</div>
<a id="gab940cb3aaf5fa67f9e557cc962821ee3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab940cb3aaf5fa67f9e557cc962821ee3">&#9670;&nbsp;</a></span>CY_PRA_GET_PORT_REG_INDEX</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CY_PRA_GET_PORT_REG_INDEX</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">base, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">subIndex&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;<a class="el" href="group__group__pra__functions.html#ga75141de8e5b3bf6600dc800b66128af6">Cy_PRA_GetPortRegIndex</a>(base, subIndex)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Compares the PORT and PIN number with secure PIN list and returns PORT index. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>GPIO Port address</td></tr>
    <tr><td class="paramname">subIndex</td><td>register index of GPIO PORT</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>PRA GPIO PORT register index </dd></dl>

</div>
</div>
<a id="ga83fb16d9d89322be1a9f69330e440c5d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga83fb16d9d89322be1a9f69330e440c5d">&#9670;&nbsp;</a></span>CY_PRA_GET_HSIOM_REG_INDEX</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CY_PRA_GET_HSIOM_REG_INDEX</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">base, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">subIndex&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;<a class="el" href="group__group__pra__functions.html#ga5850ddafe9e4383265d32842f6124854">Cy_PRA_GetHsiomRegIndex</a>(base, subIndex)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Compares the PORT with secure PIN list and returns HSIOM port index. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>GPIO Port address</td></tr>
    <tr><td class="paramname">subIndex</td><td>register index of HSIOM PORT</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>PRA HSIOM PORT register index </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
